Skip to main content

Managing Reports

This guide covers administrator tasks in Settings → My reports: browsing report definitions, creating new views, importing and exporting configurations, and opening the editor for an existing report.

Opening the Report Management Console​

  1. Open the Report Builder portal.
  2. Click the gear icon in the top-right corner of the header.
  3. Select Settings from the dropdown menu.
  4. The My reports page opens at /settings.

The My reports page lists every report definition in the environment. Each row shows:

ColumnDescription
CheckboxSelects the report for bulk export
Report IDUnique identifier (for example, 6, 3456, 0000001)
Name and descriptionDisplay title and optional subtitle
View typeQUERY, MULTI_QUERY, or DASHBOARD
Gear iconOpens the configuration editor for that report

Searching and Selecting Reports​

  1. Click the Search bar at the top of the page.
  2. Enter part of a report name, ID, or description.
  3. The list filters to matching entries.

Select All​

  1. Click Select All to check every visible report row.
  2. Click Export Selected (.json) to export the selected definitions (see below).

Adding a New Report​

  1. On the My reports page, click Add New Report.
  2. The Add New View dialog opens.
  3. Fill in the required fields:
FieldDescription
Report IdentifierUnique ID for the report (for example, 3456). Used in the View List and render URLs.
Report NameDisplay name shown to users (for example, sumo-user-guide).
Report DescriptionOptional summary of the report's purpose.
View TypeSelect Query, Multi Query, or Dashboard depending on what you are building.
  1. Click Add.
  2. The system navigates to the Add Section editor for the new report (for query types) or the appropriate builder for the selected view type.

After creating a query report, continue with Creating Query Reports to write the SQL and save the section.

Editing an Existing Report​

  1. On the My reports page, locate the report you want to change.

  2. Click the gear icon on the right side of the report row.

  3. The configuration editor opens for that report type:

    • QUERY → SQL editor with parameters and actions sidebar
    • MULTI_QUERY → section builder for multiple query parts
    • DASHBOARD → dashboard layout and chart configuration

  4. Make your changes and click Save (floppy disk icon) to persist the configuration.

Exporting Report Definitions​

Use export to back up report configurations or move them to another environment.

  1. On the My reports page, select one or more reports using the row checkboxes.
  2. Click Export Selected (.json).
  3. The browser downloads a JSON file containing the selected report definitions.

Note: The Export Selected (.json) button remains disabled until at least one report is selected.

Importing Report Definitions​

  1. On the My reports page, click Import Reports (.json).
  2. Select a valid report JSON file from your local machine.
  3. Confirm the import when prompted.
  4. Imported reports appear in the My reports list and become available in the View List for authorized users.

View Type Reference​

Choose the correct view type when creating a new report:

View TypeWhen to Use
QueryA single SQL statement rendered as a searchable table.
Multi QueryMultiple related query sections grouped under one report identifier.
DashboardCharts and visual panels with interactive filters such as date range.

After Saving a Report​

Once a report is saved:

  1. It appears in My reports with the configured ID, name, and view type.
  2. Authorized users see it in the View List.
  3. Process designers can reference it from a Report Stage using Select View.
  4. End users can run it following the steps in Running Reports.